Modify Subscriber SIM Status

Modify Subscriber SIM Status API is used to modify subscriber card status. Modifying card status can be applied in two different ways:

  • Use a ‘Reset’ command to unlock a locked card.
  • Change status from one status to another .

Successful response with a request ID indicates that the status modification request was submitted successfully. It does not indicate that the request was successfully executed on the SIM card.

HTTP URL  
PUT api/v2/subscriber/{type}/{value}/sim-status

NOTE: All {type} and {value} pairs, define the search criteria. Valid {type} ENUMs are: ‘imsi’, ‘iccid’, ‘msisdn’, ‘imei’.

Eligibility

The Requestor is eligible to reset his own subscribers' SIM cards regardless of their actual existence (which level they reside in).

API Request

Parameter Type M/O/CM Description
status String O

New requested status. Valid ENUM values:

  • RESET Reset means that the system will change the card status to free (‘idle’), hence unlocking a locked SIM card
  • Default if not provided = RESET

API Response

Response Structure

Parameter Type M/O/CM Description
errorCode String O Failure code.
errorMessage String O Failure detailed description.
content Object O Array of main response body object. Displayed when an API call was successful. For a failure it will be empty.
pageable Object O Paging information object. Displayed when an API call was successful. For a failure it will be empty.

Content

Parameter Type M/O/CM Description
requestId UUID M Request instance ID. To be used by external systems to query the call (operation) status, whether in progress, successful or failed.

Pageable data objects

Element

Type

M/O/CM

Description
page Numeric M Page number
size Numeric M Page size. Number of requested elements per page
totalPages Numeric M Total amount of available pages per requested page size
totalElements Numeric M Total amount of retrieved elements

Error Codes

In addition to the general success and failure codes, the following error codes are possible.

Code Message
GLOBAL_1001 Service unavailable. Please try again
SUBSCRIBER_1002

Subscriber does not exist.

Examples

Request Body

Copy 
{
  "status": "RESET"
}

Response Body: Success ACK

Copy 
{
  "errorCode": "",
  "errorMessage": "",
  "content": [
    {
      "requestId": "ff74dca6-8e7f-4b85-a42b-13860913b370"
    }
  ],
  "pageable": null
}

Response Body: Failure NAK

Copy 
{
  "errorCode": "GLOBAL_1001",
  "errorMessage": "Service unavailable. Please try again",
  "content": "",
  "pageable": null
}